(x-select-text): Add a doc string.
authorEli Zaretskii <eliz@gnu.org>
Fri, 24 Jul 2009 16:32:47 +0000 (16:32 +0000)
committerEli Zaretskii <eliz@gnu.org>
Fri, 24 Jul 2009 16:32:47 +0000 (16:32 +0000)
lisp/term/pc-win.el

index 39bf5f1725410bddf1fd962993bc0c6d2ffb6e78..6e295c63d4abbb8c1108c76724bb87d6ae9c6605 100644 (file)
@@ -210,6 +210,19 @@ set by Emacs is not accessible to other programs on Windows.\)"
   :group 'killing)
 
 (defun x-select-text (text &optional push)
+  "Select TEXT, a string, according to the window system.
+
+On X, put TEXT in the primary X selection.  For backward
+compatibility with older X applications, set the value of X cut
+buffer 0 as well, and if the optional argument PUSH is non-nil,
+rotate the cut buffers.  If `x-select-enable-clipboard' is
+non-nil, copy the text to the X clipboard as well.
+
+On Windows, make TEXT the current selection.  If
+`x-select-enable-clipboard' is non-nil, copy the text to the
+clipboard as well.  The argument PUSH is ignored.
+
+On Nextstep, put TEXT in the pasteboard; PUSH is ignored."
   (if x-select-enable-clipboard
       (w16-set-clipboard-data text))
   (setq x-last-selected-text text))